home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr29 / mkey12.zip / MKEY.DOC < prev    next >
Text File  |  1991-12-18  |  8KB  |  193 lines
  1.  
  2.  
  3.  
  4.                                       MKey
  5.  
  6.  
  7.                                                             Version 1
  8.                                                                 Rev 0
  9.  
  10.  
  11.         by Gary Chanson
  12.         (C) 1991
  13.  
  14.  
  15.             MKey and MCONFIG are Copyright 1991 by Gary Chanson and 
  16.             Starquest Systems.  No restrictions  are placed  on the 
  17.             use or copying of these programs,  except that they may 
  18.             not be used  for commercial purposes without a license.
  19.  
  20.  
  21.     Description:
  22.  
  23.         MKey is an event handler for the PC mouse which translates mouse 
  24.         events  such as  movement  and  button presses  into  keystrokes 
  25.         usable by application software.  MKey installs a tiny (less than 
  26.         600 bytes)  resident program  attached to your mouse driver.  It 
  27.         is re-configurable and removeable.  It can be also be re-enabled 
  28.         if an application disables it.
  29.  
  30.         MKey  can  generate  any  scan code  a  keyboard  can  generate.  
  31.         Keystrokes  can  be generated  on any  movement, on pressing  or 
  32.         releasing either button, or on pressing both buttons  (the third 
  33.         button  on three  button mice  is not  supported).  The  scaling 
  34.         factor for movement is also customizable.
  35.  
  36.         MKey can read its configuration  from a data file and comes with 
  37.         a  configuration  program  (MCONFIG.COM)   which  produces  MKey 
  38.         configuration files.
  39.  
  40.         MKey saves  the state of the mouse driver event handler  when it 
  41.         is loaded  and  restores it  when removed.  This feature  can be 
  42.         used  to  shield  programs  which  use  the  mouse   from  being 
  43.         de-activated  by  other programs  which might  be executed  from 
  44.         within it.
  45.  
  46.         MKey  can  be  used  within  multitasking  environments  such as 
  47.         DESQview (tm)  from  within  several windows  simultaneously, as 
  48.         long as it is installed after the multitasker is running, and in 
  49.         each window which it will be used within.
  50.  
  51.  
  52.     Usage:
  53.  
  54.         MKey must be loaded  before any application with which you would 
  55.         like to use the mouse.  If you have created a configuration file 
  56.         for your application, its name (and path)  should be included in 
  57.         the command tail.   For instance, if your application is  QEDIT, 
  58.         and you have  a configuration file called  QEDIT.MKC  located in 
  59.         C:\UTILS, the command would look like:
  60.  
  61.             MKEY C:\UTILS\QEDIT.MKC
  62.  
  63.         After using  QEDIT, run  MKey again, and replace  the  file name 
  64.         with  the `R' switch  (/r or -r)  to remove  the resident  event 
  65.         handler.
  66.  
  67.         If you use  several applications, you can run MKey  between them 
  68.         to re-configure  it for  each application.  You  do not  have to 
  69.         remove it until you are done.  Each time it is run, it will look 
  70.         for the resident event handler, and the re-configuration will be 
  71.         performed on it.  Note that MKey can not search upper memory for 
  72.         the resident event handler.
  73.  
  74.         You can force MKey to ignore any resident event handler already 
  75.         installed by using the `N' switch.  This allows for nesting one 
  76.         application within another without interference.
  77.  
  78.         Running MKey  with no options  or file names  will re-enable the 
  79.         current configuration without changing it.  This is useful if an 
  80.         application  which already uses the mouse is run, and leaves the 
  81.         mouse driver disabled.  The `D' switch is useful  when the mouse 
  82.         might interfere with the operation of an application.  MKey will 
  83.         remain disabled until run again.
  84.  
  85.         The `Q' switch suppresses display of error messages.
  86.  
  87.         Running MKey with the `?' switch  displays a help screen and the 
  88.         revision level.
  89.  
  90.         If  you  are running  MKey  from a  batch file (most likely, you 
  91.         are), you  can use  ERRORLEVEL  to  test for  MKey  errors.  See 
  92.         "Error levels" for a listing of codes returned.  Your batch file 
  93.         might look like this:
  94.  
  95.             MKEY c:\utils\qedit.mkc
  96.             IF ERRORLEVEL 1  QUIT
  97.  
  98.             QEDIT %1 %2 %3 %4
  99.  
  100.             MKEY -r
  101.  
  102.  
  103.     Configuration:
  104.  
  105.         MKey comes  with a configuration program  call MCONFIG.  MCONFIG 
  106.         generates  configuration files which MKey  can read to setup its 
  107.         configuration  for  each  application.  To  create  or  modify a 
  108.         configuration file,run MCONFIG with the file name as its command 
  109.         tail.  If the file name  does not have an extension, the default 
  110.         extension `.MKC' will be used.  Running MCONFIG without any tail 
  111.         displays  a brief  help screen.  To modify (or create)  the file 
  112.         QEDIT.MKC in C:\UTILS enter:
  113.  
  114.             MCONFIG c:\utils\qedit
  115.  
  116.         MCONFIG displays a menu of all of MKey's configurable parameters 
  117.         and displays  their current settings.  For each of the 9 events, 
  118.         the name of the key assigned is shown (disabled events are shown 
  119.         as `[disabled]').  The scale factors for vertical and horizontal 
  120.         movement  are also shown.  Movement scale factors  are displayed 
  121.         in "Mickeys per character".
  122.  
  123.         To change  a setting,  press  the  hot key  for the  appropriate 
  124.         function.  MCONFIG  will prompt you  for a key to assign to that 
  125.         function.   You  can enter  any key  or key combination  at this 
  126.         prompt.  To disable a function, enter `ctrl @' (this key can not 
  127.         be entered by MCONFIG, but can  be patched  into data files with 
  128.         DEBUG  or a hex editor).  To modify  the movement scale factors, 
  129.         select  the  `V' or `H'  choices  from  the  menu.  You  will be 
  130.         prompted  for a  new  setting.  Numbers  are  assumed  to be  in 
  131.         decimal unless prefaces with a `$'.
  132.  
  133.         When you have completed modifications to the configuration file, 
  134.         press  `X'  to  save  the  file  and  exit  MCONFIG.   To  abort 
  135.         modifications,  press `Q'  to quit MCONFIG  without saving file.
  136.  
  137.  
  138.     Switches:
  139.  
  140.         -d      Disable event handler
  141.         -n      Nest event handlers
  142.         -r      Remove event handler
  143.         -q      Quiet; suppresses display of error messages
  144.         -?      display help screen
  145.  
  146.  
  147.     Error levels:
  148.  
  149.         0       no error
  150.         1       configuration file not found
  151.         2       un-recognized option switch
  152.         3       no resident handler found (not removed)
  153.         4       no mouse driver found
  154.  
  155.  
  156.     Patching:
  157.  
  158.         The format of MKey configuration files is the same as the format 
  159.         of MKey's parameter table.  The parameter table is located at an 
  160.         offset of 3 bytes  in the MKEY.COM file (address 103H in DEBUG).  
  161.         Each event has a 2 byte entry in the parameter table.  The first 
  162.         byte is the ASCII code  and the second byte is the scan code  of 
  163.         the keystroke  which  will  be feed  into the  keyboard  buffer.  
  164.         Vertical and horizontal  movement scale factors  are each one 16 
  165.         bit word.  The table has 11 entries totaling 22 bytes.
  166.  
  167.           offset    default   key     function
  168.             00      4800H     up      movement up
  169.             02      5000H     down    movement down
  170.             04      4B00H     left    movement left
  171.             06      4D00H     right   movement right
  172.             08      0000H             left button press
  173.             10      000DH     enter   left button release
  174.             12      0000H             right button press
  175.             14      001BH     esc     right button release
  176.             16      3B00H     F1      both buttons pressed
  177.             18        24              vert speed (mickeys/char)
  178.             20        24              horz speed (mickeys/char)
  179.  
  180.  
  181.     -----------------------------------------------------------------------
  182.  
  183.             Please forward all comments and bug reports to:
  184.  
  185.                 Gary Chanson
  186.  
  187.                 360 Waltham Street
  188.                 West Newton, MA  USA  02165-1732
  189.  
  190.                 Voice:  617-527-7206
  191.  
  192.                 Email:  BCS-IBM BBS - 617-332-5584
  193.